Skip to content

[Doc] Initialize headless docs content based on RA docs#10891

Merged
fzaninotto merged 40 commits intomasterfrom
headless-doc-content
Sep 5, 2025
Merged

[Doc] Initialize headless docs content based on RA docs#10891
fzaninotto merged 40 commits intomasterfrom
headless-doc-content

Conversation

@slax57
Copy link
Contributor

@slax57 slax57 commented Aug 21, 2025

Problem

Now that the headless docs website is ready, we need to fill its content.

Solution

Create the headless docs website content by adapting the RA docs where applicable.

TODO

  • Getting Started: to write

Guides & Concepts

  • General Concepts
  • Data Fetching
  • CRUD Pages: replace by base components, remove layouts and filters
  • Forms
  • Security
  • Routing
  • I18N
  • Preferences
  • All Features (curated)

App Configuration

  • <Admin> -> CoreAdmin
  • <Resource>
  • <CustomRoutes>

Data Fetching

  • all

Security

  • all

List Page

  • Introduction (curated)
  • Filtering the List (curated)
  • <ListBase>
  • <InfiniteListBase>
  • <ListIterator>
  • <FilterLiveForm>
  • <WithListContext>
  • useListContext
  • useList
  • useListController
  • useUnselect
  • useUnselectAll
  • <DataTable> (will be done later)

Creation & Edition Pages

  • Introduction
  • Form Validation
  • <CreateBase>
  • <EditBase>
  • <Form>
  • useCreateContext
  • useCreateController
  • useEditContext
  • useEditController
  • useSaveContext
  • useRecordFromLocation
  • useRegisterMutationMiddleware
  • useUnique

Show Page

  • Introduction
  • <ShowBase>
  • useShowContext
  • useShowController

Common

  • <WithRecord>
  • useRecordContext
  • useGetRecordId
  • useNotify
  • useRedirect
  • useRefresh

Fields

  • Introduction
  • Fields for Relationships
  • <ArrayField> <- could be moved to ra-core
  • <FieldTitle> (will be done later)
  • <ReferenceFieldBase>
  • <ReferenceArrayFieldBase>
  • <ReferenceManyFieldBase>
  • <ReferenceManyCountBase>
  • <ReferenceOneFieldBase>
  • useFieldValue

Inputs

  • Introduction
  • <ArrayInput> <- NO EQUIVALENT! Should provide an ArrayInputBase -- will be done later
  • <InputHelperText> <- could be moved to ra-core -- will be done later
  • <ReferenceInputBase> (will be done later)
  • <ReferenceArrayInputBase> (will be done later)
  • useInput

Preferences

  • useStore
  • useRemoveFromStore
  • useResetStore
  • useStoreContext

I18N Provider & Translations

  • Setting Up
  • Supported Locales
  • Translating UI Components
  • Writing an i18nProvider
  • <Translate>
  • useTranslate
  • useLocaleState

Other Hooks & Components

  • useCheckForApplicationUpdate (will be done later)
  • <RecordRepresentation>
  • useGetRecordRepresentation

Recipes

  • Caching
  • Unit Testing

  • Confirm Enterprise features are out of scope for now
  • Should I copy the Community page?
  • Contributing page?
  • Clean up img folder
  • Fix videos
  • Actually no need for manually using CoreAdminUI + CoreAdminContext, CoreAdmin does that!
  • Global check: ReferenceInput can easily be replaced by ReferenceInputBase
  • Improve props tables layout (1st column gets cut)
  • Manually order sidebar entries
  • Rename page title from 'React Admin Headless' to 'ra-core'

Screenshots

localhost_4321_ra-core_ localhost_4321_ra-core_getting-started_

Additional Checks

  • The PR targets master for a bugfix or a documentation fix, or next for a feature
  • [ ] The PR includes unit tests (if not possible, describe why)
  • [ ] The PR includes one or several stories (if not possible, describe why)
  • The documentation is up to date

Also, please make sure to read the contributing guidelines.

@slax57 slax57 added the WIP Work In Progress label Aug 21, 2025
@slax57
Copy link
Contributor Author

slax57 commented Sep 4, 2025

Back to WIP: need to change the files organization to be flat instead of using sub-folders

@slax57 slax57 added WIP Work In Progress and removed RFR Ready For Review labels Sep 4, 2025
@slax57
Copy link
Contributor Author

slax57 commented Sep 4, 2025

Back to RFR!

Copy link
Contributor

@djhi djhi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 💪

@fzaninotto fzaninotto merged commit b39bde5 into master Sep 5, 2025
16 checks passed
@fzaninotto fzaninotto deleted the headless-doc-content branch September 5, 2025 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

RFR Ready For Review

Development

Successfully merging this pull request may close these issues.

3 participants